home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / lisp / wgdb-42.lha / wgdb-4.2 / gdb / symtab.h < prev    next >
C/C++ Source or Header  |  1992-09-11  |  36KB  |  937 lines
  1. /* Symbol table definitions for GDB.
  2.    Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
  3.  
  4. This file is part of GDB.
  5.  
  6. This program is free software; you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation; either version 2 of the License, or
  9. (at your option) any later version.
  10.  
  11. This program is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. GNU General Public License for more details.
  15.  
  16. You should have received a copy of the GNU General Public License
  17. along with this program; if not, write to the Free Software
  18. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20. #if !defined (SYMTAB_H)
  21. #define SYMTAB_H 1
  22. #include <obstack.h>
  23.  
  24. /* An obstack to hold objects that should be freed
  25.    when we load a new symbol table.
  26.    This includes the symbols made by dbxread
  27.    and the types that are not permanent.  */
  28.  
  29. extern struct obstack *symbol_obstack;
  30. extern struct obstack *psymbol_obstack;
  31.  
  32. /* Some definitions and declarations to go with use of obstacks.  */
  33. #define obstack_chunk_alloc xmalloc
  34. #define obstack_chunk_free free
  35. #ifdef __STDC__
  36. extern void *xmalloc ();
  37. #else
  38. extern char *xmalloc ();
  39. #endif
  40. extern void free ();
  41.  
  42. /* Some macros for char-based bitfields.  */
  43. #define B_SET(a,x) (a[x>>3] |= (1 << (x&7)))
  44. #define B_CLR(a,x) (a[x>>3] &= ~(1 << (x&7)))
  45. #define B_TST(a,x) (a[x>>3] & (1 << (x&7)))
  46. #define B_TYPE        unsigned char
  47. #define    B_BYTES(x)    ( 1 + ((x)>>3) )
  48. #define    B_CLRALL(a,x) bzero (a, B_BYTES(x))
  49.  
  50. /* gdb can know one or several symbol tables at the same time;
  51.    the ultimate intent is to have one for each separately-compiled module.
  52.    Each such symbol table is recorded by a struct symtab, and they
  53.    are all chained together.  */
  54.  
  55. /* In addition, gdb can record any number of miscellaneous undebuggable
  56.    functions' addresses.  In a system that appends _ to function names,
  57.    the _'s are removed from the names stored in this table.  */
  58.  
  59. /* Actually, the misc function list is used to store *all* of the
  60.    global symbols (text, data, bss, and abs).  It is sometimes used
  61.    to figure out what symtabs to read in.  The "type" field is used
  62.    occasionally.  Calling it the misc "function" vector is now a misnomer.
  63.  
  64.    The misc_info field is available for machine-specific information
  65.    that can be cached along with a misc function vector entry.  The
  66.    AMD 29000 tdep.c uses it to remember things it has decoded from the
  67.    instructions in the function header, so it doesn't have to rederive
  68.    the info constantly (over a serial line).  It is initialized to zero
  69.    and stays that way until target-dependent code sets it.  */
  70.  
  71. enum misc_function_type {mf_unknown = 0, mf_text, mf_data, mf_bss, mf_abs};
  72.  
  73. struct misc_function
  74. {
  75.   char *name;
  76.   CORE_ADDR address;
  77.   char *misc_info;    /* Random pointer to misc info.  void * but for old C */
  78.   enum misc_function_type type;
  79. };
  80.  
  81. /* Address and length of the vector recording all misc function names/addresses.  */
  82.  
  83. struct misc_function *misc_function_vector;
  84. int misc_function_count;
  85.  
  86. /* Different kinds of data types are distinguished by the `code' field.  */
  87.  
  88. enum type_code
  89. {
  90.   TYPE_CODE_UNDEF,        /* Not used; catches errors */
  91.   TYPE_CODE_PTR,        /* Pointer type */
  92.   TYPE_CODE_ARRAY,        /* Array type, lower bound zero */
  93.   TYPE_CODE_STRUCT,        /* C struct or Pascal record */
  94.   TYPE_CODE_UNION,        /* C union or Pascal variant part */
  95.   TYPE_CODE_ENUM,        /* Enumeration type */
  96.   TYPE_CODE_FUNC,        /* Function type */
  97.   TYPE_CODE_INT,        /* Integer type */
  98.   TYPE_CODE_FLT,        /* Floating type */
  99.   TYPE_CODE_VOID,        /* Void type (values zero length) */
  100.   TYPE_CODE_SET,        /* Pascal sets */
  101.   TYPE_CODE_RANGE,        /* Range (integers within spec'd bounds) */
  102.   TYPE_CODE_PASCAL_ARRAY,    /* Array with explicit type of index */
  103.   TYPE_CODE_ERROR,              /* Unknown type */
  104.  
  105.   /* C++ */
  106.   TYPE_CODE_MEMBER,        /* Member type */
  107.   TYPE_CODE_METHOD,        /* Method type */
  108.   TYPE_CODE_REF,        /* C++ Reference types */
  109.  
  110.   /* Modula-2 */
  111.   TYPE_CODE_CHAR,        /* *real* character type */
  112.   TYPE_CODE_BOOL,        /* Builtin Modula-2 BOOLEAN */
  113. };
  114.  
  115. /* This appears in a type's flags word for an unsigned integer type.  */
  116. #define TYPE_FLAG_UNSIGNED 1
  117. /* This appears in a type's flags word
  118.    if it is a (pointer to a|function returning a)* built in scalar type.
  119.    These types are never freed.  */
  120. #define TYPE_FLAG_PERM 4
  121. /* This appears in a type's flags word if it is a stub type (eg. if
  122.    someone referenced a type that wasn't definined in a source file
  123.    via (struct sir_not_appearing_in_this_film *)).  */
  124. #define TYPE_FLAG_STUB 8
  125. /* Set when a class has a constructor defined */
  126. #define    TYPE_FLAG_HAS_CONSTRUCTOR    256
  127. /* Set when a class has a destructor defined */
  128. #define    TYPE_FLAG_HAS_DESTRUCTOR    512
  129.  
  130. struct type
  131. {
  132.   /* Code for kind of type */
  133.   enum type_code code;
  134.   /* Name of this type, or zero if none.
  135.      This is used for printing only, except by poorly designed C++ code.
  136.      Type names specified as input are defined by symbols.  */
  137.   char *name;
  138.   /* Length in bytes of storage for a value of this type */
  139.   unsigned length;
  140.   /* For a pointer type, describes the type of object pointed to.
  141.      For an array type, describes the type of the elements.
  142.      For a function or method type, describes the type of the value.
  143.      For a range type, describes the type of the full range.
  144.      Unused otherwise.  */
  145.   struct type *target_type;
  146.   /* Type that is a pointer to this type.
  147.      Zero if no such pointer-to type is known yet.
  148.      The debugger may add the address of such a type
  149.      if it has to construct one later.  */ 
  150.   struct type *pointer_type;
  151.   /* C++: also need a reference type.  */
  152.   struct type *reference_type;
  153.   struct type **arg_types;
  154.   
  155.   /* Type that is a function returning this type.
  156.      Zero if no such function type is known here.
  157.      The debugger may add the address of such a type
  158.      if it has to construct one later.  */
  159.   struct type *function_type;
  160.  
  161. /* Handling of pointers to members:
  162.    TYPE_MAIN_VARIANT is used for pointer and pointer
  163.    to member types.  Normally it the value of the address of its
  164.    containing type.  However, for pointers to members, we must be
  165.    able to allocate pointer to member types and look them up
  166.    from some place of reference.
  167.    NEXT_VARIANT is the next element in the chain.
  168.  
  169.    A long time ago (Jul 88; GDB 2.5) Tiemann said that main_variant
  170.    may no longer be necessary and that he might eliminate it.  I don't
  171.    know whether this is still true (or ever was).  */
  172.   struct type *main_variant, *next_variant;
  173.  
  174.   /* Flags about this type.  */
  175.   short flags;
  176.   /* Number of fields described for this type */
  177.   short nfields;
  178.   /* For structure and union types, a description of each field.
  179.      For set and pascal array types, there is one "field",
  180.      whose type is the domain type of the set or array.
  181.      For range types, there are two "fields",
  182.      the minimum and maximum values (both inclusive).
  183.      For enum types, each possible value is described by one "field".
  184.  
  185.      Using a pointer to a separate array of fields
  186.      allows all types to have the same size, which is useful
  187.      because we can allocate the space for a type before
  188.      we know what to put in it.  */
  189.   struct field
  190.     {
  191.       /* Position of this field, counting in bits from start of
  192.      containing structure.  For a function type, this is the
  193.      position in the argument list of this argument.
  194.      For a range bound or enum value, this is the value itself.  */
  195.       int bitpos;
  196.       /* Size of this field, in bits, or zero if not packed.
  197.      For an unpacked field, the field's type's length
  198.      says how many bytes the field occupies.  */
  199.       int bitsize;
  200.       /* In a struct or enum type, type of this field.
  201.      In a function type, type of this argument.
  202.      In an array type, the domain-type of the array.  */
  203.       struct type *type;
  204.       /* Name of field, value or argument.
  205.      Zero for range bounds and array domains.  */
  206.       char *name;
  207.     } *fields;
  208.  
  209.   /* C++ */
  210.   B_TYPE *virtual_field_bits; /* if base class is virtual */
  211.   B_TYPE *private_field_bits;
  212.   B_TYPE *protected_field_bits;
  213.  
  214.   /* Number of methods described for this type */
  215.   short nfn_fields;
  216.   /* Number of base classes this type derives from. */
  217.   short n_baseclasses;
  218.  
  219.   /* Number of methods described for this type plus all the
  220.      methods that it derives from.  */
  221.   int nfn_fields_total;
  222.  
  223.   /* For classes, structures, and unions, a description of each field,
  224.      which consists of an overloaded name, followed by the types of
  225.      arguments that the method expects, and then the name after it
  226.      has been renamed to make it distinct.  */
  227.   struct fn_fieldlist
  228.     {
  229.       /* The overloaded name.  */
  230.       char *name;
  231.       /* The number of methods with this name.  */
  232.       int length;
  233.       /* The list of methods.  */
  234.       struct fn_field
  235.     {
  236. #if 0
  237.       /* The overloaded name */
  238.       char *name;
  239. #endif
  240.       /* The return value of the method */
  241.       struct type *type;
  242.       /* The argument list */
  243.       struct type **args;
  244.       /* The name after it has been processed */
  245.       char *physname;
  246.  
  247.       /* For virtual functions.   */
  248.       /* First baseclass that defines this virtual function.   */
  249.       struct type *fcontext;
  250.       /* Index into that baseclass's virtual function table,
  251.          minus 1; else if static: VOFFSET_STATIC; else: 0.  */
  252.       int voffset;
  253. #      define VOFFSET_STATIC (-1)
  254.     } *fn_fields;
  255.  
  256.       B_TYPE *private_fn_field_bits;
  257.       B_TYPE *protected_fn_field_bits;
  258.  
  259.     } *fn_fieldlists;
  260.  
  261.   unsigned char via_protected;
  262.   unsigned char via_public;
  263.  
  264.   /* For types with virtual functions, VPTR_BASETYPE is the base class which
  265.      defined the virtual function table pointer.  VPTR_FIELDNO is
  266.      the field number of that pointer in the structure.
  267.  
  268.      For types that are pointer to member types, VPTR_BASETYPE
  269.      ifs the type that this pointer is a member of.
  270.  
  271.      Unused otherwise.  */
  272.   struct type *vptr_basetype;
  273.  
  274.   int vptr_fieldno;
  275. };
  276.  
  277. /* All of the name-scope contours of the program
  278.    are represented by `struct block' objects.
  279.    All of these objects are pointed to by the blockvector.
  280.  
  281.    Each block represents one name scope.
  282.    Each lexical context has its own block.
  283.  
  284.    The first two blocks in the blockvector are special.
  285.    The first one contains all the symbols defined in this compilation
  286.    whose scope is the entire program linked together.
  287.    The second one contains all the symbols whose scope is the
  288.    entire compilation excluding other separate compilations.
  289.    In C, these correspond to global symbols and static symbols.
  290.  
  291.    Each block records a range of core addresses for the code that
  292.    is in the scope of the block.  The first two special blocks
  293.    give, for the range of code, the entire range of code produced
  294.    by the compilation that the symbol segment belongs to.
  295.  
  296.    The blocks appear in the blockvector
  297.    in order of increasing starting-address,
  298.    and, within that, in order of decreasing ending-address.
  299.  
  300.    This implies that within the body of one function
  301.    the blocks appear in the order of a depth-first tree walk.  */
  302.  
  303. struct blockvector
  304. {
  305.   /* Number of blocks in the list.  */
  306.   int nblocks;
  307.   /* The blocks themselves.  */
  308.   struct block *block[1];
  309. };
  310.  
  311. /* Special block numbers */
  312. #define GLOBAL_BLOCK    0
  313. #define    STATIC_BLOCK    1
  314. #define    FIRST_LOCAL_BLOCK    2
  315.  
  316. struct block
  317. {
  318.   /* Addresses in the executable code that are in this block.
  319.      Note: in an unrelocated symbol segment in a file,
  320.      these are always zero.  They can be filled in from the
  321.      N_LBRAC and N_RBRAC symbols in the loader symbol table.  */
  322.   CORE_ADDR startaddr, endaddr;
  323.   /* The symbol that names this block,
  324.      if the block is the body of a function;
  325.      otherwise, zero.
  326.      Note: In an unrelocated symbol segment in an object file,
  327.      this field may be zero even when the block has a name.
  328.      That is because the block is output before the name
  329.      (since the name resides in a higher block).
  330.      Since the symbol does point to the block (as its value),
  331.      it is possible to find the block and set its name properly.  */
  332.   struct symbol *function;
  333.   /* The `struct block' for the containing block, or 0 if none.  */
  334.   /* Note that in an unrelocated symbol segment in an object file
  335.      this pointer may be zero when the correct value should be
  336.      the second special block (for symbols whose scope is one compilation).
  337.      This is because the compiler ouptuts the special blocks at the
  338.      very end, after the other blocks.   */
  339.   struct block *superblock;
  340.   /* A flag indicating whether or not the fucntion corresponding
  341.      to this block was compiled with gcc or not.  If there is no
  342.      function corresponding to this block, this meaning of this flag
  343.      is undefined.  (In practice it will be 1 if the block was created
  344.      while processing a file compiled with gcc and 0 when not). */
  345.   unsigned char gcc_compile_flag;
  346.   /* Number of local symbols.  */
  347.   int nsyms;
  348.   /* The symbols.  */
  349.   struct symbol *sym[1];
  350. };
  351.  
  352. /* Represent one symbol name; a variable, constant, function or typedef.  */
  353.  
  354. /* Different name spaces for symbols.  Looking up a symbol specifies
  355.    a namespace and ignores symbol definitions in other name spaces.
  356.  
  357.    VAR_NAMESPACE is the usual namespace.
  358.    In C, this contains variables, function names, typedef names
  359.    and enum type values.
  360.  
  361.    STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
  362.    Thus, if `struct foo' is used in a C program,
  363.    it produces a symbol named `foo' in the STRUCT_NAMESPACE.
  364.  
  365.    LABEL_NAMESPACE may be used for names of labels (for gotos);
  366.    currently it is not used and labels are not recorded at all.  */
  367.  
  368. /* For a non-global symbol allocated statically,
  369.    the correct core address cannot be determined by the compiler.
  370.    The compiler puts an index number into the symbol's value field.
  371.    This index number can be matched with the "desc" field of
  372.    an entry in the loader symbol table.  */
  373.  
  374. enum namespace
  375. {
  376.   UNDEF_NAMESPACE, VAR_NAMESPACE, STRUCT_NAMESPACE, LABEL_NAMESPACE,
  377. };
  378.  
  379. /* An address-class says where to find the value of a symbol.  */
  380.  
  381. enum address_class
  382. {
  383.   LOC_UNDEF,        /* Not used; catches errors */
  384.   LOC_CONST,        /* Value is constant int SYMBOL_VALUE, host byteorder */
  385.   LOC_STATIC,        /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
  386.   LOC_REGISTER,        /* Value is in register */
  387.   LOC_ARG,        /* Value is at spec'd offset in arglist */
  388.   LOC_REF_ARG,        /* Value address is at spec'd offset in arglist. */
  389.   LOC_REGPARM,        /* Value is at spec'd offset in register window */
  390.   LOC_LOCAL,        /* Value is at spec'd offset in stack frame */
  391.   LOC_TYPEDEF,        /* Value not used; definition in SYMBOL_TYPE
  392.                Symbols in the namespace STRUCT_NAMESPACE
  393.                all have this class.  */
  394.   LOC_LABEL,        /* Value is address SYMBOL_VALUE_ADDRESS in the code */
  395.   LOC_BLOCK,        /* Value is address SYMBOL_VALUE_BLOCK of a
  396.                `struct block'.  Function names have this class. */
  397.   LOC_CONST_BYTES,    /* Value is a constant byte-sequence pointed to by
  398.                SYMBOL_VALUE_ADDRESS, in target byte order.  */
  399.   LOC_LOCAL_ARG,    /* Value is arg at spec'd offset in stack frame.
  400.                Differs from LOC_LOCAL in that symbol is an
  401.                argument; differs from LOC_ARG in that we find it
  402.                in the frame (FRAME_LOCALS_ADDRESS), not in the
  403.                arglist (FRAME_ARGS_ADDRESS).  Added for i960,
  404.                which passes args in regs then copies to frame.  */
  405. };
  406.  
  407. struct symbol
  408. {
  409.   /* Symbol name */
  410.   char *name;
  411.   /* Name space code.  */
  412.   enum namespace namespace;
  413.   /* Address class */
  414.   enum address_class class;
  415.   /* Data type of value */
  416.   struct type *type;
  417.  
  418.   /* Line number of definition.  */
  419.   unsigned short line;
  420.   
  421.   /* constant value, or address if static, or register number,
  422.      or offset in arguments, or offset in stack frame.  All of
  423.      these are in host byte order (though what they point to might
  424.      be in target byte order, e.g. LOC_CONST_BYTES).  */
  425.   union
  426.     {
  427.       long value;        /* for LOC_CONST, LOC_REGISTER, LOC_ARG, 
  428.                    LOC_REF_ARG, LOC_REGPARM, LOC_LOCAL */
  429.       struct block *block;      /* for LOC_BLOCK */
  430.       char *bytes;        /* for LOC_CONST_BYTES */
  431.       CORE_ADDR address;    /* for LOC_STATIC, LOC_LABEL */
  432.       struct symbol *chain;    /* for opaque typedef struct chain */
  433.     }
  434.   value;
  435. };
  436.  
  437.  
  438. /* A partial_symbol records the name, namespace, and address class of
  439.    symbols whose types we have not parsed yet.  For functions, it also
  440.    contains their memory address, so we can find them from a PC value.
  441.    Each partial_symbol sits in a partial_symtab, all of which are chained
  442.    on the partial_symtab_list and which points to the corresponding 
  443.    normal symtab once the partial_symtab has been referenced.  */
  444.  
  445. struct partial_symbol
  446. {
  447.   /* Symbol name */
  448.   char *name;
  449.   /* Name space code.  */
  450.   enum namespace namespace;
  451.   /* Address class (for info_symbols) */
  452.   enum address_class class;
  453.   /* Value (only used for static functions currently).  Done this
  454.      way so that we can use the struct symbol macros.
  455.      Note that the address of a function is SYMBOL_VALUE_ADDRESS (pst)
  456.      in a partial symbol table, but BLOCK_START (SYMBOL_BLOCK_VALUE (st))
  457.      in a symbol table.  */
  458.   union
  459.     {
  460.       long value;
  461.       CORE_ADDR address;
  462.     }
  463.   value;
  464. };
  465.  
  466. /* Source-file information.
  467.    This describes the relation between source files and line numbers
  468.    and addresses in the program text.  */
  469.  
  470. struct sourcevector
  471. {
  472.   int length;            /* Number of source files described */
  473.   struct source *source[1];    /* Descriptions of the files */
  474. };
  475.  
  476. /* Each item represents a line-->pc (or the reverse) mapping.  This is
  477.    somewhat more wasteful of space than one might wish, but since only
  478.    the files which are actually debugged are read in to core, we don't
  479.    waste much space.
  480.  
  481.    Each item used to be an int; either minus a line number, or a
  482.    program counter.  If it represents a line number, that is the line
  483.    described by the next program counter value.  If it is positive, it
  484.    is the program counter at which the code for the next line starts.  */
  485.  
  486. struct linetable_entry
  487. {
  488.   int line;
  489.   CORE_ADDR pc;
  490. };
  491.  
  492. struct linetable
  493. {
  494.   int nitems;
  495.   struct linetable_entry item[1];
  496. };
  497.  
  498. /* All the information on one source file.  */
  499.  
  500. struct source
  501. {
  502.   char *name;            /* Name of file */
  503.   struct linetable contents;
  504. };
  505.  
  506. /* Each source file is represented by a struct symtab. 
  507.    These objects are chained through the `next' field.  */
  508.  
  509. struct symtab
  510.   {
  511.     /* Chain of all existing symtabs.  */
  512.     struct symtab *next;
  513.     /* List of all symbol scope blocks for this symtab.  */
  514.     struct blockvector *blockvector;
  515.     /* Table mapping core addresses to line numbers for this file.  */
  516.     struct linetable *linetable;
  517.     /* Name of this source file.  */
  518.     char *filename;
  519.     /* Directory in which it was compiled, or NULL if we don't know.  */
  520.     char *dirname;
  521.     /* This component says how to free the data we point to:
  522.        free_contents => do a tree walk and free each object.
  523.        free_nothing => do nothing; some other symtab will free
  524.          the data this one uses.
  525.        free_linetable => free just the linetable.  */
  526.     enum free_code {free_nothing, free_contents, free_linetable}
  527.       free_code;
  528.     /* Pointer to one block of storage to be freed, if nonzero.  */
  529.     /* This is IN ADDITION to the action indicated by free_code.  */
  530.     char *free_ptr;
  531.     /* Total number of lines found in source file.  */
  532.     int nlines;
  533.     /* Array mapping line number to character position.  */
  534.     int *line_charpos;
  535.     /* Language of this source file.  */
  536.     enum language language;
  537.     /* String of version information.  May be zero.  */
  538.     char *version;
  539.     /* Full name of file as found by searching the source path.
  540.        0 if not yet known.  */
  541.     char *fullname;
  542.  
  543.     /* Anything extra for this symtab.  This is for target machines
  544.        with special debugging info of some sort (which cannot just
  545.        be represented in a normal symtab).  */
  546. #if defined (EXTRA_SYMTAB_INFO)
  547.     EXTRA_SYMTAB_INFO
  548. #endif
  549.   };
  550.  
  551. /* Each source file that has not been fully read in is represented by
  552.    a partial_symtab.  This contains the information on where in the
  553.    executable the debugging symbols for a specific file are, and a
  554.    list of names of global symbols which are located in this file.
  555.    They are all chained on partial_symtab_list.
  556.  
  557.    Even after the source file has been read into a symtab, the
  558.    partial_symtab remains around.  They are allocated on an obstack,
  559.    psymbol_obstack.  FIXME, this is bad for dynamic linking or VxWorks-
  560.    style execution of a bunch of .o's.  */
  561. struct partial_symtab
  562. {
  563.   /* Chain of all existing partial symtabs.  */
  564.   struct partial_symtab *next;
  565.   /* Name of the source file which this partial_symtab defines */
  566.   char *filename;
  567.  
  568.   /* Name of the symbol file from which symbols should be read.  */
  569.   char *symfile_name;
  570.   /* Address relative to which the symbols in this file are.  Need to
  571.      relocate by this amount when reading in symbols from the symbol
  572.      file.  */
  573.   CORE_ADDR addr;
  574.  
  575.   /* Information that lets *read_symtab (below) locate the part of the
  576.      symbol table that this psymtab corresponds to.  This information
  577.      is private to the format-dependent symbol reading routines.
  578.  
  579.      For dbxread: Offset within file symbol table of first local symbol for
  580.      this file, and length (in bytes) of the section of the symbol table
  581.      devoted to this file's symbols (actually, the section bracketed
  582.      may contain more than just this file's symbols).
  583.      If ldsymlen is 0, the only reason for this thing's existence is
  584.      the dependency list below.  Nothing else will happen when it is
  585.      read in.
  586.  
  587.      For mipsread:  ldsymoff is the index of the FDR that this psymtab
  588.      represents; ldsymlen points to the symbol table header HDRR from
  589.      the symbol file that the psymtab was created from.  */
  590.   int ldsymoff, ldsymlen;
  591.  
  592.   /* Range of text addresses covered by this file; texthigh is the
  593.      beginning of the next section. */
  594.   CORE_ADDR textlow, texthigh;
  595.   /* Array of pointers to all of the partial_symtab's which this one
  596.      depends on.  Since this array can only be set to previous or
  597.      the current (?) psymtab, this dependency tree is guaranteed not
  598.      to have any loops. */
  599.   struct partial_symtab **dependencies;
  600.   int number_of_dependencies;
  601.   /* Global symbol list.  This list will be sorted after readin to
  602.      improve access.  Binary search will be the usual method of
  603.      finding a symbol within it. globals_offset is an integer offset
  604.      within global_psymbols[].  */
  605.   int globals_offset, n_global_syms;
  606.   /* Static symbol list.  This list will *not* be sorted after readin;
  607.      to find a symbol in it, exhaustive search must be used.  This is
  608.      reasonable because searches through this list will eventually
  609.      lead to either the read in of a files symbols for real (assumed
  610.      to take a *lot* of time; check) or an error (and we don't care
  611.      how long errors take).  This is an offset and size within
  612.      static_psymbols[].  */
  613.   int statics_offset, n_static_syms;
  614.   /* Pointer to symtab eventually allocated for this source file, 0 if
  615.      !readin or if we haven't looked for the symtab after it was readin.  */
  616.   struct symtab *symtab;
  617.   /* Pointer to function which will read in the symtab corresponding to
  618.      this psymtab.  */
  619.   void (*read_symtab) ();
  620.   /* Non-zero if the symtab corresponding to this psymtab has been
  621.      readin */
  622.   unsigned char readin;
  623. };
  624.  
  625. /* A fast way to get from a psymtab to its symtab (after the first time).  */
  626. #define    PSYMTAB_TO_SYMTAB(pst)  ((pst)->symtab?         \
  627.                  (pst)->symtab:         \
  628.                  psymtab_to_symtab (pst) )
  629.  
  630. /* This is the list of struct symtab's that gdb considers current.  */
  631.  
  632. struct symtab *symtab_list;
  633.  
  634. /* This is the list of struct partial_symtab's that gdb may need to access */
  635.  
  636. struct partial_symtab *partial_symtab_list;
  637.  
  638. /* This symtab variable specifies the current file for printing source lines */
  639.  
  640. struct symtab *current_source_symtab;
  641.  
  642. /* This is the next line to print for listing source lines.  */
  643.  
  644. int current_source_line;
  645.  
  646. #define BLOCKLIST(symtab) (symtab)->blockvector
  647. #define BLOCKVECTOR(symtab) (symtab)->blockvector
  648.  
  649. #define LINELIST(symtab) (symtab)->linetable
  650. #define LINETABLE(symtab) (symtab)->linetable
  651.  
  652. /* Macros normally used to access components of symbol table structures.  */
  653.  
  654. #define BLOCKLIST_NBLOCKS(blocklist) (blocklist)->nblocks
  655. #define BLOCKLIST_BLOCK(blocklist,n) (blocklist)->block[n]
  656. #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
  657. #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
  658.  
  659. #define BLOCK_START(bl) (bl)->startaddr
  660. #define BLOCK_END(bl) (bl)->endaddr
  661. #define BLOCK_NSYMS(bl) (bl)->nsyms
  662. #define BLOCK_SYM(bl, n) (bl)->sym[n]
  663. #define BLOCK_FUNCTION(bl) (bl)->function
  664. #define BLOCK_SUPERBLOCK(bl) (bl)->superblock
  665. #define BLOCK_GCC_COMPILED(bl) (bl)->gcc_compile_flag
  666.  
  667. /* Nonzero if symbols of block BL should be sorted alphabetically.  */
  668. #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40)
  669.  
  670. #define SYMBOL_NAME(symbol) (symbol)->name
  671. #define SYMBOL_NAMESPACE(symbol) (symbol)->namespace
  672. #define SYMBOL_CLASS(symbol) (symbol)->class
  673. #define SYMBOL_VALUE(symbol) (symbol)->value.value
  674. #define SYMBOL_VALUE_ADDRESS(symbol) (symbol)->value.address
  675. #define SYMBOL_VALUE_BYTES(symbol) (symbol)->value.bytes
  676. #define SYMBOL_BLOCK_VALUE(symbol) (symbol)->value.block
  677. #define SYMBOL_VALUE_CHAIN(symbol) (symbol)->value.chain
  678. #define SYMBOL_TYPE(symbol) (symbol)->type
  679. #define SYMBOL_LINE(symbol) (symbol)->line
  680.  
  681. #define TYPE_NAME(thistype) (thistype)->name
  682. #define TYPE_TARGET_TYPE(thistype) (thistype)->target_type
  683. #define TYPE_POINTER_TYPE(thistype) (thistype)->pointer_type
  684. #define TYPE_REFERENCE_TYPE(thistype) (thistype)->reference_type
  685. #define TYPE_FUNCTION_TYPE(thistype) (thistype)->function_type
  686. #define TYPE_MAIN_VARIANT(thistype) (thistype)->main_variant
  687. #define TYPE_NEXT_VARIANT(thistype) (thistype)->next_variant
  688. #define TYPE_LENGTH(thistype) (thistype)->length
  689. #define TYPE_FLAGS(thistype) (thistype)->flags
  690. #define TYPE_UNSIGNED(thistype) ((thistype)->flags & TYPE_FLAG_UNSIGNED)
  691. #define TYPE_CODE(thistype) (thistype)->code
  692. #define TYPE_NFIELDS(thistype) (thistype)->nfields
  693. #define TYPE_FIELDS(thistype) (thistype)->fields
  694. /* C++ */
  695. #define TYPE_VPTR_BASETYPE(thistype) (thistype)->vptr_basetype
  696. #define TYPE_DOMAIN_TYPE(thistype) (thistype)->vptr_basetype
  697. #define TYPE_VPTR_FIELDNO(thistype) (thistype)->vptr_fieldno
  698. #define TYPE_FN_FIELDS(thistype) (thistype)->fn_fields
  699. #define TYPE_NFN_FIELDS(thistype) (thistype)->nfn_fields
  700. #define TYPE_NFN_FIELDS_TOTAL(thistype) (thistype)->nfn_fields_total
  701. #define TYPE_ARG_TYPES(thistype) (thistype)->arg_types
  702. #define TYPE_BASECLASS(thistype,index) (thistype)->fields[index].type
  703. #define TYPE_N_BASECLASSES(thistype) (thistype)->n_baseclasses
  704. #define TYPE_BASECLASS_NAME(thistype,index) (thistype)->fields[index].name
  705. #define TYPE_BASECLASS_BITPOS(thistype,index) (thistype)->fields[index].bitpos
  706. #define BASETYPE_VIA_PUBLIC(thistype, index) (!TYPE_FIELD_PRIVATE(thistype, index))
  707. #define BASETYPE_VIA_VIRTUAL(thistype, index) B_TST((thistype)->virtual_field_bits, (index))
  708.  
  709. #define TYPE_FIELD(thistype, n) (thistype)->fields[n]
  710. #define TYPE_FIELD_TYPE(thistype, n) (thistype)->fields[n].type
  711. #define TYPE_FIELD_NAME(thistype, n) (thistype)->fields[n].name
  712. #define TYPE_FIELD_VALUE(thistype, n) (* (int*) &(thistype)->fields[n].type)
  713. #define TYPE_FIELD_BITPOS(thistype, n) (thistype)->fields[n].bitpos
  714. #define TYPE_FIELD_BITSIZE(thistype, n) (thistype)->fields[n].bitsize
  715. #define TYPE_FIELD_PACKED(thistype, n) (thistype)->fields[n].bitsize
  716.  
  717. #define TYPE_FIELD_PRIVATE_BITS(thistype) (thistype)->private_field_bits
  718. #define TYPE_FIELD_PROTECTED_BITS(thistype) (thistype)->protected_field_bits
  719. #define TYPE_FIELD_VIRTUAL_BITS(thistype) (thistype)->virtual_field_bits
  720. #define SET_TYPE_FIELD_PRIVATE(thistype, n) B_SET ((thistype)->private_field_bits, (n))
  721. #define SET_TYPE_FIELD_PROTECTED(thistype, n) B_SET ((thistype)->protected_field_bits, (n))
  722. #define SET_TYPE_FIELD_VIRTUAL(thistype, n) B_SET ((thistype)->virtual_field_bits, (n))
  723. #define TYPE_FIELD_PRIVATE(thistype, n) B_TST((thistype)->private_field_bits, (n))
  724. #define TYPE_FIELD_PROTECTED(thistype, n) B_TST((thistype)->protected_field_bits, (n))
  725. #define TYPE_FIELD_VIRTUAL(thistype, n) B_TST((thistype)->virtual_field_bits, (n))
  726.  
  727. #define TYPE_HAS_DESTRUCTOR(thistype) ((thistype)->flags & TYPE_FLAG_HAS_DESTRUCTOR)
  728. #define TYPE_HAS_CONSTRUCTOR(thistype) ((thistype)->flags & TYPE_FLAG_HAS_CONSTRUCTOR)
  729.  
  730. #define TYPE_FIELD_STATIC(thistype, n) ((thistype)->fields[n].bitpos == -1)
  731. #define TYPE_FIELD_STATIC_PHYSNAME(thistype, n) ((char *)(thistype)->fields[n].bitsize)
  732.  
  733. #define TYPE_FN_FIELDLISTS(thistype) (thistype)->fn_fieldlists
  734. #define TYPE_FN_FIELDLIST(thistype, n) (thistype)->fn_fieldlists[n]
  735. #define TYPE_FN_FIELDLIST1(thistype, n) (thistype)->fn_fieldlists[n].fn_fields
  736. #define TYPE_FN_FIELDLIST_NAME(thistype, n) (thistype)->fn_fieldlists[n].name
  737. #define TYPE_FN_FIELDLIST_LENGTH(thistype, n) (thistype)->fn_fieldlists[n].length
  738.  
  739. #define TYPE_FN_FIELD(thistype, n) (thistype)[n]
  740. #define TYPE_FN_FIELD_NAME(thistype, n) (thistype)[n].name
  741. #define TYPE_FN_FIELD_TYPE(thistype, n) (thistype)[n].type
  742. #define TYPE_FN_FIELD_ARGS(thistype, n) TYPE_ARG_TYPES ((thistype)[n].type)
  743. #define TYPE_FN_FIELD_PHYSNAME(thistype, n) (thistype)[n].physname
  744. #define TYPE_FN_FIELD_VIRTUAL_P(thistype, n) ((thistype)[n].voffset > 0)
  745. #define TYPE_FN_FIELD_STATIC_P(thistype, n) ((thistype)[n].voffset == VOFFSET_STATIC)
  746. #define TYPE_FN_FIELD_VOFFSET(thistype, n) ((thistype)[n].voffset-1)
  747. #define TYPE_FN_FIELD_FCONTEXT(thistype, n) ((thistype)[n].fcontext)
  748.  
  749. #define TYPE_FN_PRIVATE_BITS(thistype) (thistype).private_fn_field_bits
  750. #define TYPE_FN_PROTECTED_BITS(thistype) (thistype).protected_fn_field_bits
  751. #define SET_TYPE_FN_PRIVATE(thistype, n) B_SET ((thistype).private_fn_field_bits, n)
  752. #define SET_TYPE_FN_PROTECTED(thistype, n) B_SET ((thistype).protected_fn_field_bits, n)
  753. #define TYPE_FN_PRIVATE(thistype, n) B_TST ((thistype).private_fn_field_bits, n)
  754. #define TYPE_FN_PROTECTED(thistype, n) B_TST ((thistype).protected_fn_field_bits, n)
  755.  
  756. /* The virtual function table is now an array of structures
  757.    which have the form { int16 offset, delta; void *pfn; }. 
  758.  
  759.    In normal virtual function tables, OFFSET is unused.
  760.    DELTA is the amount which is added to the apparent object's base
  761.    address in order to point to the actual object to which the
  762.    virtual function should be applied.
  763.    PFN is a pointer to the virtual function.  */
  764.   
  765. #define VTBL_FNADDR_OFFSET 2
  766.  
  767. /* Macro that yields non-zero value iff NAME is the prefix
  768.    for C++ operator names.  If you leave out the parenthesis
  769.    here you will lose!
  770.  
  771.    Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
  772.    symbol-file and the names in gdb's symbol table.  */
  773. #define OPNAME_PREFIX_P(NAME) ((NAME)[0] == 'o' && (NAME)[1] == 'p' \
  774.                    && (NAME)[2] == CPLUS_MARKER)
  775.  
  776. #define VTBL_PREFIX_P(NAME) ((NAME)[3] == CPLUS_MARKER    \
  777.                  && !strncmp ((NAME), "_vt", 3))
  778.  
  779. /* Functions that work on the objects described above */
  780.  
  781. extern struct symtab *lookup_symtab ();
  782. extern struct symbol *lookup_symbol ();
  783. extern struct symbol *lookup_block_symbol ();
  784. extern int lookup_misc_func ();
  785. extern void check_stub_type ();
  786. extern void check_stub_method ();
  787. extern struct type *lookup_primitive_typename ();
  788. extern struct type *lookup_typename ();
  789. extern struct type *lookup_unsigned_typename ();
  790. extern struct type *lookup_struct ();
  791. extern struct type *lookup_union ();
  792. extern struct type *lookup_enum ();
  793. extern struct type *lookup_struct_elt_type ();
  794. extern struct type *lookup_pointer_type ();
  795. extern struct type *lookup_function_type ();
  796. extern struct type *lookup_basetype_type ();
  797. extern struct type *create_array_type ();
  798. extern struct symbol *block_function ();
  799. extern struct symbol *find_pc_function ();
  800. extern int find_pc_partial_function ();
  801. extern void clear_pc_function_cache ();
  802. extern struct partial_symtab *lookup_partial_symtab ();
  803. extern struct partial_symtab *find_pc_psymtab ();
  804. extern struct symtab *find_pc_symtab ();
  805. extern struct partial_symbol *find_pc_psymbol ();
  806. extern int find_pc_misc_function ();
  807. extern int find_pc_line_pc_range ();
  808. extern char *type_name_no_tag ();
  809. extern int contained_in();
  810.  
  811. /* C++ stuff.  */
  812. extern struct type *lookup_reference_type ();
  813. extern struct type *lookup_member_type ();
  814. extern struct type *lookup_method_type ();
  815. extern struct type *lookup_class ();
  816. extern void smash_to_method_type ();
  817. void smash_to_member_type (
  818. #ifdef __STDC__
  819.                struct type *, struct type *, struct type *
  820. #endif
  821.                );
  822. extern struct type *allocate_stub_method ();
  823. /* end of C++ stuff.  */
  824.  
  825. extern void free_all_symtabs ();
  826. extern void free_all_psymtabs ();
  827. extern void free_inclink_symtabs ();
  828. extern void reread_symbols ();
  829.  
  830. extern struct type *builtin_type_void;
  831. extern struct type *builtin_type_char;
  832. extern struct type *builtin_type_short;
  833. extern struct type *builtin_type_int;
  834. extern struct type *builtin_type_long;
  835. extern struct type *builtin_type_unsigned_char;
  836. extern struct type *builtin_type_unsigned_short;
  837. extern struct type *builtin_type_unsigned_int;
  838. extern struct type *builtin_type_unsigned_long;
  839. extern struct type *builtin_type_float;
  840. extern struct type *builtin_type_double;
  841. /* This type represents a type that was unrecognized in symbol
  842.    read-in.  */
  843. extern struct type *builtin_type_error;
  844.  
  845. extern struct type *builtin_type_long_long;
  846. extern struct type *builtin_type_unsigned_long_long;
  847.  
  848. /* Modula-2 types */
  849. extern struct type *builtin_type_m2_char;
  850. extern struct type *builtin_type_m2_int;
  851. extern struct type *builtin_type_m2_card;
  852. extern struct type *builtin_type_m2_real;
  853. extern struct type *builtin_type_m2_bool;
  854.  
  855. /* LONG_LONG is defined if the host has "long long".  */
  856. #ifdef LONG_LONG
  857. #define BUILTIN_TYPE_LONGEST builtin_type_long_long
  858. #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long_long
  859. /* This should not be a typedef, because "unsigned LONGEST" needs
  860.    to work.  */
  861. #define LONGEST long long
  862.  
  863. #else /* not LONG_LONG.  */
  864.  
  865. #define BUILTIN_TYPE_LONGEST builtin_type_long
  866. #define BUILTIN_TYPE_UNSIGNED_LONGEST builtin_type_unsigned_long
  867. #define LONGEST long
  868.  
  869. #endif /* not LONG_LONG.  */
  870.  
  871. struct symtab_and_line
  872. {
  873.   struct symtab *symtab;
  874.   int line;
  875.   CORE_ADDR pc;
  876.   CORE_ADDR end;
  877. };
  878.  
  879. struct symtabs_and_lines
  880. {
  881.   struct symtab_and_line *sals;
  882.   int nelts;
  883. };
  884.  
  885. /* Given a pc value, return line number it is in.
  886.    Second arg nonzero means if pc is on the boundary
  887.    use the previous statement's line number.  */
  888.  
  889. struct symtab_and_line find_pc_line ();
  890.  
  891. /* Given a symtab and line number, return the pc there.  */
  892. extern CORE_ADDR find_line_pc ();
  893. extern int find_line_pc_range ();
  894.  
  895. /* Given a string, return the line specified by it.
  896.    For commands like "list" and "breakpoint".  */
  897.  
  898. struct symtabs_and_lines decode_line_spec ();
  899. struct symtabs_and_lines decode_line_spec_1 ();
  900. struct symtabs_and_lines decode_line_1 ();
  901.  
  902. /* Symmisc.c */
  903. void free_symtab ();
  904.  
  905. /* Symbol-reading stuff in symfile.c and solib.c.  */
  906. struct symtab *psymtab_to_symtab ();
  907. void clear_solib ();
  908. void symbol_file_add ();
  909.  
  910. /* source.c */
  911. int identify_source_line ();
  912. void print_source_lines ();
  913. void forget_cached_source_info (
  914. #ifdef __STDC__
  915.                 void
  916. #endif
  917.                 );
  918. void select_source_symtab (
  919. #ifdef __STDC__
  920.                struct symtab *
  921. #endif
  922.                );
  923.  
  924. char **make_symbol_completion_list ();
  925.  
  926. /* The entry point of a file we are reading.  */
  927. extern CORE_ADDR entry_point;
  928.  
  929. /* Maximum and minimum values of built-in types */
  930. #define    MAX_OF_TYPE(t)    \
  931.    TYPE_UNSIGNED(t) ? UMAX_OF_SIZE(TYPE_LENGTH(t)) : MAX_OF_SIZE(TYPE_LENGTH(t))
  932.  
  933. #define MIN_OF_TYPE(t)    \
  934.    TYPE_UNSIGNED(t) ? UMIN_OF_SIZE(TYPE_LENGTH(t)) : MIN_OF_SIZE(TYPE_LENGTH(t))
  935.  
  936. #endif /* symtab.h not already included.  */
  937.